Installing and Configuring the Plugin

The following prerequisites must be met before installing the Plugin ManagerAction Builder PluginDeployment Pipeline Plugin:

Condition Required for Done
AWI has to be installed. (Visit Automic Download Center) Installing the Plugin
The latest version of the Offering ARA (11.2.2) is installed. That includes ARA 6.0.1, AE 11.2.1 and AWI12.0.0 (Visit Automic Download Center) Installing the Plugin

For more information see UC_CLIENT_SETTINGS - Various Client Settings in the Settings in Variables chapter of the AE Administration guide.

SEARCH_SCRIPT_FOR_USAGE

The search for object use in script.

Allowed values: "Y", "L" and "N" (default value)

"Y" - Search for objects used in scripts (with regular expressions).
"L" - Search for objects used in scripts (normal search without regular expressions).
"N" -  No search for object usage in scripts.

No

When deleting, renaming or manually searching the use of an object, AE checks if this object is used in other objects as well (for example, in Schedule objects). If so, you can have a list of all these objects displayed. With the specification of the key SEARCH_SCRIPT_FOR_USAGE and the values "Y" and "L", objects that are used in scripts (for example,  ACTIVATE_UC_OBJECT) are included in the search. There are different search types:

"Y" - The searched string is handled as a word that is enclosed in delimiters such as blanks, left and right parentheses, equals, commas, single quotations, double quotations, end of lines and script ends.

For example: Searching for MM only lists results in which this term is enclosed in the listed delimiters.

  • (MM)
  • =MM=
  • 'MM'
  • (MM,
  • =MM at the end of a line

Underscores are not delimiters. Searching for MM is not successful if you search for _MM_.

Note that this search specification is only supported for the MS SQL Server and Oracle version 10g and beyond.

Searching by using the option "Y" is more complex and takes longer.

"L" - The searched string must be somewhere in the script as otherwise, it is not displayed as a search result.

For example: Searching for MM lists results in which this term is included as a whole or partially.

  • MM
  • MM.CLOSING
  • AE.MM.DAY
Cloning Actions

Optional configuration settings

Setting Required for Done

In order to enable logging, add the following snippet to the logback.xml file in the config folder of the webapps/<awi-webapp-folder> directory on your Tomcat server:

<logger name="com.automic.apm" level="WARN" additivity="false">

<appender-ref ref="LOGGER"/>
</logger>
Enabling logging

Installing the Plugin

The Action Builder PluginPlugin Manager is delivered as a .zip file which contains a .jar file.

To install the Plugin, the .jar file must be copied to the autoinstall folder within the webapps/ directory of the Tomcat server running AWI.

If your ARA/ASO system was set up by the ONE Installer, this should be: <installer-root>/External.Resources/apache-tomcat-x.x.xx/webapps/<awi-webapp-folder>/WEB-INF/autoinstall.

The Plugin is available and ready to be used on the Action Packs accordion tab of the navigation sidebar, under the Process Assembly perspective.

After restarting your session, the Plugin is available and ready to be used on the Packs accordion tab of the navigation sidebar, under the Administration perspective.

Configuring the Plugin

Configuration is optional and can be done via the actionbuilder.properties file located in /webapps/<awi-webapp-folder>/config/awi-plugins-actionbuilder-<yourversion> in your Tomcat installation.

The following values are configurable and used as defaults when creating new Action Packs:

  • Company name:

    scaffolding.package_company = Custom

  • Dependencies:

    #scaffolding.package_dependencies =

    As long as you do not have additional dependencies, leave this unchanged.

  • Company website:

    scaffolding.package_homepage = www.yourcompany.com

  • Action Pack prefix:

    scaffolding.package_title_prefix = CUSTOM_

Troubleshooting Problems on Plugin Installation

If you experience issues when installing the Plugin, check to see whether this comes from one of the known issues:

Possible cause Solution
The 12.0 AWI version is not installed. Download the latest version from the Automic Download Center

The AWIlog and messages can also provide useful information to identify the problem(s) preventing the Plugin from being installed.

The version of the Plugin can be retrieved from the log file or the About dialog of the AWI.

For more information see the Installing and Configuring the ARA Plugin for AWI section in the ARA Installation guide.